GET residentapi/myunits/{myUnitId}/events?startDate={startDate}&endDate={endDate}&includeCancelledEvents={includeCancelledEvents}&calendarIds[0]={calendarIds[0]}&calendarIds[1]={calendarIds[1]}

Returns a combination list of events from both cws and connect. If both start and end dates are not provided, the return set will be the between the first and last day of the current month

Request Information

URI Parameters

NameDescriptionTypeAdditional information
myUnitId

Cws MyUnitId

integer

Required

startDate

Filter for events that begin on or after this date (Will also show 7 days prior to this date to account for a calendar view)

date

None.

endDate

Filter for events that end on or before this date (Will also show 14 days after this date to account for a calendar view and upcoming events in cws)

date

None.

includeCancelledEvents

Determines whether or not to show cancelled events

boolean

False

calendarIds

Filter for events that are associated to at least one of the calendarId values in this list

Collection of integer

None.

Body Parameters

None.

Response Information

Resource Description

ListWrapperOfEvent
NameDescriptionTypeAdditional information
Total

integer

None.

Elements

Collection of Event

None.

Response Formats

application/json, text/json

Sample:
{
  "total": 1,
  "elements": [
    {
      "eventId": 1,
      "propertyId": 2,
      "committeeId": 1,
      "categoryId": 1,
      "subCategoryId": 1,
      "title": "sample string 3",
      "description": "sample string 4",
      "location": "sample string 5",
      "dateStart": "2025-12-24T09:16:49.1284396-05:00",
      "dateEnd": "2025-12-24T09:16:49.1284396-05:00",
      "hyperlinkLabel": "sample string 6",
      "hyperlinkUrl": "sample string 7",
      "fee": 1.0,
      "isCancelled": true,
      "calendar": {
        "calendarId": 1,
        "name": "sample string 2"
      },
      "isCwsEvent": true,
      "photos": [
        {
          "photoId": 1,
          "eventId": 2,
          "fileUrl": "sample string 3",
          "isDefault": true
        },
        {
          "photoId": 1,
          "eventId": 2,
          "fileUrl": "sample string 3",
          "isDefault": true
        }
      ],
      "attachments": [
        {
          "fileName": "sample string 1",
          "fileUrl": "sample string 2"
        },
        {
          "fileName": "sample string 1",
          "fileUrl": "sample string 2"
        }
      ],
      "locations": [
        {
          "name": "sample string 1",
          "address1": "sample string 2",
          "address2": "sample string 3",
          "city": "sample string 4",
          "state": "sample string 5",
          "zip": "sample string 6",
          "country": "sample string 7"
        },
        {
          "name": "sample string 1",
          "address1": "sample string 2",
          "address2": "sample string 3",
          "city": "sample string 4",
          "state": "sample string 5",
          "zip": "sample string 6",
          "country": "sample string 7"
        }
      ]
    },
    {
      "eventId": 1,
      "propertyId": 2,
      "committeeId": 1,
      "categoryId": 1,
      "subCategoryId": 1,
      "title": "sample string 3",
      "description": "sample string 4",
      "location": "sample string 5",
      "dateStart": "2025-12-24T09:16:49.1284396-05:00",
      "dateEnd": "2025-12-24T09:16:49.1284396-05:00",
      "hyperlinkLabel": "sample string 6",
      "hyperlinkUrl": "sample string 7",
      "fee": 1.0,
      "isCancelled": true,
      "calendar": {
        "calendarId": 1,
        "name": "sample string 2"
      },
      "isCwsEvent": true,
      "photos": [
        {
          "photoId": 1,
          "eventId": 2,
          "fileUrl": "sample string 3",
          "isDefault": true
        },
        {
          "photoId": 1,
          "eventId": 2,
          "fileUrl": "sample string 3",
          "isDefault": true
        }
      ],
      "attachments": [
        {
          "fileName": "sample string 1",
          "fileUrl": "sample string 2"
        },
        {
          "fileName": "sample string 1",
          "fileUrl": "sample string 2"
        }
      ],
      "locations": [
        {
          "name": "sample string 1",
          "address1": "sample string 2",
          "address2": "sample string 3",
          "city": "sample string 4",
          "state": "sample string 5",
          "zip": "sample string 6",
          "country": "sample string 7"
        },
        {
          "name": "sample string 1",
          "address1": "sample string 2",
          "address2": "sample string 3",
          "city": "sample string 4",
          "state": "sample string 5",
          "zip": "sample string 6",
          "country": "sample string 7"
        }
      ]
    }
  ]
}